/*
 * Copyright (c) 2011 Imre Fazekas.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the Brillien nor the names of its
 * terms and concepts may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.vii.streamline.services.reflection;

import com.vii.streamline.services.error.StreamLineException;

import java.util.List;
import java.util.Map;

/**
 * This interfaces defines basic methods to gather information about services.
 */
public interface Invocable {

    /**
     * Tells whether this invocation is recognized or not.
     */
    boolean                 isMethodReckognised( Invocation invocation );

    /**
     * Tells whether the given procedure has a return value
     */
    boolean                 hasMessageProcessorReturnValue( Invocation invocation ) throws StreamLineException;

    /**
     * Retrieves the parameter names of the called procedure
     */
    List<String>            getParameterNames( Invocation invocation ) throws StreamLineException;

    /**
     * Retrieves the parameter types of the called procedure
     */
    List<Class>             getParameterTypes( Invocation invocation ) throws StreamLineException;

    /**
     * Retrieves the parameter map of the called procedure
     */
    Map<String,Class>       getParameterMap( Invocation invocation ) throws StreamLineException;

    /**
     * Executes an Invocation object
     */
    Object                  execute( Invocation invocation ) throws StreamLineException;

}
